home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib / tcl / Interp.man < prev    next >
Encoding:
Text File  |  1992-08-07  |  9.0 KB  |  303 lines
  1. '\"
  2. '\" Copyright 1989 Regents of the University of California
  3. '\" Permission to use, copy, modify, and distribute this
  4. '\" documentation for any purpose and without fee is hereby
  5. '\" granted, provided that this notice appears in all copies.
  6. '\" The University of California makes no representations about
  7. '\" the suitability of this material for any purpose.  It is
  8. '\" provided "as is" without express or implied warranty.
  9. '\" 
  10. '\" $Header: /user6/ouster/tcl/man/RCS/Interp.man,v 1.7 91/12/06 10:35:00 ouster Exp $ SPRITE (Berkeley)
  11. '\" 
  12. .\" The definitions below are for supplemental macros used in Sprite
  13. .\" manual entries.
  14. .\"
  15. .\" .HS name section [date [version]]
  16. .\"    Replacement for .TH in other man pages.  See below for valid
  17. .\"    section names.
  18. .\"
  19. .\" .AP type name in/out [indent]
  20. .\"    Start paragraph describing an argument to a library procedure.
  21. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  22. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  23. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  24. .\"    needed;  use .AS below instead)
  25. .\"
  26. .\" .AS [type [name]]
  27. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  28. .\"    name are examples of largest possible arguments that will be passed
  29. .\"    to .AP later.  If args are omitted, default tab stops are used.
  30. .\"
  31. .\" .BS
  32. .\"    Start box enclosure.  From here until next .BE, everything will be
  33. .\"    enclosed in one large box.
  34. .\"
  35. .\" .BE
  36. .\"    End of box enclosure.
  37. .\"
  38. .\" .VS
  39. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  40. .\"    of man pages.
  41. .\"
  42. .\" .VE
  43. .\"    End of vertical sidebar.
  44. .\"
  45. .\" .DS
  46. .\"    Begin an indented unfilled display.
  47. .\"
  48. .\" .DE
  49. .\"    End of indented unfilled display.
  50. .\"
  51. '\"    # Heading for Sprite man pages
  52. .de HS
  53. .if '\\$2'cmds'       .TH \\$1 1 \\$3 \\$4
  54. .if '\\$2'lib'        .TH \\$1 3 \\$3 \\$4
  55. .if '\\$2'tcl'        .TH \\$1 3 \\$3 \\$4
  56. .if '\\$2'tk'         .TH \\$1 3 \\$3 \\$4
  57. .if t .wh -1.3i ^B
  58. .nr ^l \\n(.l
  59. .ad b
  60. ..
  61. '\"    # Start an argument description
  62. .de AP
  63. .ie !"\\$4"" .TP \\$4
  64. .el \{\
  65. .   ie !"\\$2"" .TP \\n()Cu
  66. .   el          .TP 15
  67. .\}
  68. .ie !"\\$3"" \{\
  69. .ta \\n()Au \\n()Bu
  70. \&\\$1    \\fI\\$2\\fP    (\\$3)
  71. .\".b
  72. .\}
  73. .el \{\
  74. .br
  75. .ie !"\\$2"" \{\
  76. \&\\$1    \\fI\\$2\\fP
  77. .\}
  78. .el \{\
  79. \&\\fI\\$1\\fP
  80. .\}
  81. .\}
  82. ..
  83. '\"    # define tabbing values for .AP
  84. .de AS
  85. .nr )A 10n
  86. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  87. .nr )B \\n()Au+15n
  88. .\"
  89. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  90. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  91. ..
  92. '\"    # BS - start boxed text
  93. '\"    # ^y = starting y location
  94. '\"    # ^b = 1
  95. .de BS
  96. .br
  97. .mk ^y
  98. .nr ^b 1u
  99. .if n .nf
  100. .if n .ti 0
  101. .if n \l'\\n(.lu\(ul'
  102. .if n .fi
  103. ..
  104. '\"    # BE - end boxed text (draw box now)
  105. .de BE
  106. .nf
  107. .ti 0
  108. .mk ^t
  109. .ie n \l'\\n(^lu\(ul'
  110. .el \{\
  111. .\"    Draw four-sided box normally, but don't draw top of
  112. .\"    box if the box started on an earlier page.
  113. .ie !\\n(^b-1 \{\
  114. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  115. .\}
  116. .el \}\
  117. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  118. .\}
  119. .\}
  120. .fi
  121. .br
  122. .nr ^b 0
  123. ..
  124. '\"    # VS - start vertical sidebar
  125. '\"    # ^Y = starting y location
  126. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  127. .de VS
  128. .mk ^Y
  129. .ie n 'mc \s12\(br\s0
  130. .el .nr ^v 1u
  131. ..
  132. '\"    # VE - end of vertical sidebar
  133. .de VE
  134. .ie n 'mc
  135. .el \{\
  136. .ev 2
  137. .nf
  138. .ti 0
  139. .mk ^t
  140. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  141. .sp -1
  142. .fi
  143. .ev
  144. .\}
  145. .nr ^v 0
  146. ..
  147. '\"    # Special macro to handle page bottom:  finish off current
  148. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  149. '\"    # page bottom macro.
  150. .de ^B
  151. .ev 2
  152. 'ti 0
  153. 'nf
  154. .mk ^t
  155. .if \\n(^b \{\
  156. .\"    Draw three-sided box if this is the box's first page,
  157. .\"    draw two sides but no top otherwise.
  158. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  159. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  160. .\}
  161. .if \\n(^v \{\
  162. .nr ^x \\n(^tu+1v-\\n(^Yu
  163. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  164. .\}
  165. .bp
  166. 'fi
  167. .ev
  168. .if \\n(^b \{\
  169. .mk ^y
  170. .nr ^b 2
  171. .\}
  172. .if \\n(^v \{\
  173. .mk ^Y
  174. .\}
  175. ..
  176. '\"    # DS - begin display
  177. .de DS
  178. .RS
  179. .nf
  180. .sp
  181. ..
  182. '\"    # DE - end display
  183. .de DE
  184. .fi
  185. .RE
  186. .sp .5
  187. ..
  188. .HS Tcl_Interp tcl
  189. .BS
  190. .SH NAME
  191. Tcl_Interp \- client-visible fields of interpreter structures
  192. .SH SYNOPSIS
  193. .nf
  194. \fB#include <tcl.h>\fR
  195. .sp
  196. typedef struct {
  197.     char *\fIresult\fR;
  198. .VS
  199.     Tcl_FreeProc *\fIfreeProc\fR;
  200. .VE
  201.     int \fIerrorLine\fR;
  202. } Tcl_Interp;
  203.  
  204. .VS
  205. typedef void Tcl_FreeProc(char *\fIblockPtr\fR);
  206. .VE
  207. .BE
  208.  
  209. .SH DESCRIPTION
  210. .PP
  211. The \fBTcl_CreateInterp\fR procedure returns a pointer to a Tcl_Interp
  212. structure.  This pointer is then passed into other Tcl procedures
  213. to process commands in the interpreter and perform other operations
  214. on the interpreter.  Interpreter structures contain many many fields
  215. that are used by Tcl, but only three that may be accessed by
  216. .VS
  217. clients:  \fIresult\fR, \fIfreeProc\fR, and \fIerrorLine\fR.
  218. .PP
  219. The \fIresult\fR and \fIfreeProc\fR fields are used to return
  220. results or error messages from commands.
  221. This information is returned by command procedures back to \fBTcl_Eval\fR,
  222. and by \fBTcl_Eval\fR back to its callers.
  223. The \fIresult\fR field points to the string that represents the
  224. result or error message, and the \fIfreeProc\fR field tells how
  225. to dispose of the storage for the string when it isn't needed anymore.
  226. The easiest way for command procedures to manipulate these
  227. fields is to call procedures like \fBTcl_SetResult\fR
  228. or \fBTcl_AppendResult\fR;  they
  229. will hide all the details of managing the fields.
  230. The description below is for those procedures that manipulate the
  231. fields directly.
  232. .PP
  233. Whenever a command procedure returns, it must ensure
  234. that the \fIresult\fR field of its interpreter points to the string
  235. being returned by the command.
  236. The \fIresult\fR field must always point to a valid string.
  237. If a command wishes to return no result then \fIinterp->result\fR
  238. should point to an empty string.
  239. Normally, results are assumed to be statically allocated,
  240. which means that the contents will not change before the next time
  241. \fBTcl_Eval\fR is called or some other command procedure is invoked.
  242. In this case, the \fIfreeProc\fR field must be zero.
  243. Alternatively, a command procedure may dynamically
  244. allocate its return value (e.g. using \fBmalloc\fR)
  245. and store a pointer to it in \fIinterp->result\fR.
  246. In this case, the command procedure must also set \fIinterp->freeProc\fR
  247. to the address of a procedure that can free the value (usually \fBfree\fR).
  248. If \fIinterp->freeProc\fR is non-zero, then Tcl will call \fIfreeProc\fR
  249. to free the space pointed to by \fIinterp->result\fR before it
  250. invokes the next command.
  251. If a client procedure overwrites \fIinterp->result\fR when
  252. \fIinterp->freeProc\fR is non-zero, then it is responsible for calling
  253. \fIfreeProc\fR to free the old \fIinterp->result\fR (the \fBTcl_FreeResult\fR
  254. macro should be used for this purpose).
  255. .PP
  256. \fIFreeProc\fR should have arguments and result that match the
  257. \fBTcl_FreeProc\fR declaration above:  it receives a single
  258. argument which is a pointer to the result value to free.
  259. In most applications \fBfree\fR is the only non-zero value ever
  260. used for \fIfreeProc\fR.
  261. However, an application may store a different procedure address
  262. in \fIfreeProc\fR in order to use an alternate memory allocator
  263. or in order to do other cleanup when the result memory is freed.
  264. .PP
  265. As part of processing each command, \fBTcl_Eval\fR initializes
  266. \fIinterp->result\fR
  267. and \fIinterp->freeProc\fR just before calling the command procedure for
  268. the command.  The \fIfreeProc\fR field will be initialized to zero,
  269. and \fIinterp->result\fR will point to an empty string.  Commands that
  270. do not return any value can simply leave the fields alone.
  271. .VE
  272. Furthermore, the empty string pointed to by \fIresult\fR is actually
  273. part of an array of \fBTCL_RESULT_SIZE\fR characters (approximately 200).
  274. If a command wishes to return a short string, it can simply copy
  275. it to the area pointed to by \fIinterp->result\fR.  Or, it can use
  276. the sprintf procedure to generate a short result string at the location
  277. pointed to by \fIinterp->result\fR.
  278. .PP
  279. It is a general convention in Tcl-based applications that the result
  280. of an interpreter is normally in the initialized state described
  281. in the previous paragraph.
  282. Procedures that manipulate an interpreter's result (e.g. by
  283. returning an error) will generally assume that the result
  284. has been initialized when the procedure is called.
  285. If such a procedure is to be called after the result has been
  286. changed, then \fBTcl_ResetResult\fR should be called first to
  287. reset the result to its initialized state.
  288. .PP
  289. The \fIerrorLine\fR
  290. field is valid only after \fBTcl_Eval\fR returns
  291. a \fBTCL_ERROR\fR return code.  In this situation the \fIerrorLine\fR
  292. field identifies the line number of the command being executed when
  293. the error occurred.  The line numbers are relative to the command
  294. being executed:  1 means the first line of the command passed to
  295. \fBTcl_Eval\fR, 2 means the second line, and so on.
  296. The \fIerrorLine\fR field is typically used in conjunction with
  297. \fBTcl_AddErrorInfo\fR to report information about where an error
  298. occurred.
  299. \fIErrorLine\fR should not normally be modified except by \fBTcl_Eval\fR.
  300.  
  301. .SH KEYWORDS
  302. free, initialized, interpreter, malloc, result
  303.